/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.java.source.parsing;

import javax.swing.text.StyledDocument;

/**XXX: maybe not needed anymore
 *
 * @author Tomas Zezula
 */
public interface DocumentProvider {

    /**
     *  Returns the document which was used to get source
     *  code.
     *  @return {@link StyledDocument} or null
     */
    StyledDocument getDocument ();

    /**
     * Performs an atomic action on the document.
     * May be called only if {@link DocumentProvider#getDocument}
     * returns non null
     * @param {@link Runnable} the atomic action
     * @throws IllegalStateException is thrown if the {@link JavaFileObject} has no {@link Document}
     */
    void runAtomic (Runnable r);
}
